Артефакты SA — рабочие документы и модели, фиксирующие контекст, требования и решения для синхронизации стейкхолдеров, разработки и тестирования.

Зачем

  • Быстрое погружение в предметную область и ограничения.

  • Прозрачная коммуникация и согласованность решений.

  • Трассировка требований до реализации и тестов.

Минимальный набор

Проектирование

Контракты интерфейсов

  • API: схемы запросов/ответов, ошибки, идемпотентность, версии, OpenAPI-Swagger.

  • Асинхронные: Брокеры (топики, ключи, гарантии доставки, DLQ, схема сообщений), WebSocket, • Async REST.

  • UX/UI: пользовательские потоки, прототипы, описания экранов (что должно быть реализовано).

Трассировка и приемка

  • Матрица: требование → дизайн → API/сервис → тест → дефект.

  • Чек-листы приемки по Definition of Done и НФТ (• Нефункциональные требования).

  • Актуализация: ревью артефактов на этапах 3 Амиго и перед релизом.

Как оформлять

  • Короткие определения + списки; схемы держи рядом с текстом, добавляй примеры.

  • Единственное хранилище схем/контрактов (OpenAPI, Avro/Protobuf) и понятные версии.

  • Обновляй артефакты при изменении требований/интеграций, фиксируй допущения и решения.

Пример пакета под фичу

  • Контекст и поток: контекстная диаграмма + BPMN/Sequence Diagram для ключевого сценария.

  • Контракт: OpenAPI/Avro с примерами и ошибками, правила идемпотентности/ретраев, SLA.

  • Приемка: чек-лист Definition of Done, контракт-тесты producer/consumer, контрольные примеры для QA.

Последнее обновление